143 - experiment - improved jsdoc and exported to a type definition file #149
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is just a quick experiment.
Running
yarn build
generatesindex.d.ts
in the dist folder with what seems to be reasonable type definitions.I tried to use it within a svelte typescript project (with npm link to a local copy) and it doesn't seem to acknowledge the type definitions or do anything useful, at least with VSCode. Maybe it is because of npm link or the fact that svelte consumes the code directly from src. I am not sure.
Within Intellij, the type definitions seem to be picked up and working properly within .ts files (see image) but proper tooling is missing for .svelte files so I can't check how it behaves in context.
There is a TODO item regarding typing the emitted event (finalize and consider which basically have the same shape)